com.highdeal.admin.hci
Class UnknownParameterException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.highdeal.hci.OperationFailureException
              com.highdeal.admin.hci.UnknownParameterException

All Implemented Interfaces:

OperationResult, XMLMarshallable, java.io.Serializable

public class UnknownParameterException
extends OperationFailureException

Exception thrown when trying to access the value of a system parameter that does not exist when using the Get Parameter Value operation.

See Also:

GetParameterValueOp, Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="unknownParameterException">
  <xs:complexType>
     <xs:attribute name="parameterName" type="xs:string" use="required"/>
   </xs:complexType>
 </xs:element>

Field Summary

static java.lang.String	OPERATION_NAME The operation name: "unknownParameterException"
static java.lang.String	PARAM_NAME The parameter name key

Constructor Summary

UnknownParameterException()

UnknownParameterException(java.lang.String parameterName)
Creates an UnknownParameterException initialized with a parameter name.

Method Summary

void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
java.lang.String	getMessage()
java.lang.String	getOperandReference() Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
java.lang.String	getParameterName() Gets the parameter name wanted and not found.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

The operation name: "unknownParameterException"

See Also:

Constant Field Values

PARAM_NAME

public static final java.lang.String PARAM_NAME

The parameter name key

See Also:

Constant Field Values

Constructor Detail

UnknownParameterException

public UnknownParameterException()

UnknownParameterException

public UnknownParameterException(java.lang.String parameterName)

Creates an UnknownParameterException initialized with a parameter name.

Parameters:

parameterName - The name of the parameter not found

Method Detail

getParameterName

public java.lang.String getParameterName()

Gets the parameter name wanted and not found.

Returns:

The parameter name

getOperandReference

public java.lang.String getOperandReference()

Description copied from interface: OperationResult

Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.

Specified by:

getOperandReference in interface OperationResult

Overrides:

getOperandReference in class OperationFailureException

Returns:

The operand reference of the operation result

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Parameters:

atts - The XML attributes of the current element

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Parameters:

cData - The character data to be added

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Parameters:

output - The XML output to marshal the object into